Skip to content

docs: clarify TUI and CLI terminology in README - #51

Merged
dines-rl merged 2 commits into
mainfrom
dines/TUI-not-CLI
Jan 21, 2026
Merged

docs: clarify TUI and CLI terminology in README#51
dines-rl merged 2 commits into
mainfrom
dines/TUI-not-CLI

Conversation

@dines-rl

@dines-rl dines-rl commented Jan 21, 2026

Copy link
Copy Markdown
Contributor

Description

This PR updates the README documentation to clarify the distinction between the TUI (Terminal User Interface) and CLI modes of the tool. The changes make it clearer that the tool serves two purposes: an interactive TUI mode for visual interaction and a traditional CLI mode for scripting and automation.

Type of Change

  • Documentation update

Changes Made

  • Updated tagline to describe the tool as "TUI + CLI" instead of just "CLI"
  • Clarified that interactive mode is a "TUI" (Terminal User Interface)
  • Reorganized Usage section to clearly distinguish between TUI and CLI modes
  • Added explicit examples showing TUI mode vs CLI mode usage
  • Updated feature list to highlight both TUI and CLI capabilities
  • Improved clarity throughout by using precise terminology

Testing

  • Documentation changes reviewed for clarity and accuracy
  • Build passes
  • All 192 tests pass

Checklist

  • My code follows the code style of this project
  • I have performed a self-review of my own code
  • I have updated the documentation accordingly
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes

@dines-rl

dines-rl commented Jan 21, 2026

Copy link
Copy Markdown
Contributor Author

🤖 PR Review Agent

✅ Set up devbox environment
✅ Clone repository and checkout PR
✅ Check CI/CD status

1 failed workflow(s) found
✅ Scan reviewer comments
No comments
✅ Install review tools

CI Errors to Fix

  • Job: pr-title-check

SSH in to interact: rli devbox ssh dbx_32EPbHmNqTYnEVIGAKRly
View Devbox

@dines-rl dines-rl changed the title Dines/t UI not cli docs: clarify TUI and CLI terminology in README Jan 21, 2026
@dines-rl

Copy link
Copy Markdown
Contributor Author

PR Title

docs: clarify TUI and CLI terminology in README

Summary of Changes

This PR updates the README documentation to clearly distinguish between the tool's two modes: TUI (Terminal User Interface) for interactive visual use, and CLI (Command-Line Interface) for scripting and automation. The changes improve clarity by using precise terminology throughout the documentation and reorganizing sections to better explain each mode's purpose and usage.

Review Findings

Conventions

No issues found. The documentation changes follow the existing README structure and formatting conventions. All terminology updates are applied consistently throughout the document.

KISS Principle

No issues found. The changes are straightforward documentation updates that improve clarity without adding unnecessary complexity. The reorganization of the Usage section is clear and well-structured.

Code Duplication

No issues found. The documentation updates replace generic "CLI" terminology with more specific "TUI" or "CLI" terms as appropriate. No duplicate content was introduced.

CI/Build Errors

Fixed: PR Title Check Failure

The PR originally failed the pr-title-check CI job because the title "Dines/t UI not cli" did not follow the Conventional Commits format required by the repository.

Resolution: Updated the PR title to docs: clarify TUI and CLI terminology in README, which follows the Conventional Commits specification:

  • Type: docs (documentation update)
  • Description: Clear, concise explanation of the change
  • Format: Matches the required pattern for automatic release notes generation

This fix resolves the CI failure without requiring any code changes.

Verification Results

Build

PASSED - TypeScript compilation completed successfully with no errors.

> @runloop/rl-cli@1.2.0 build
> tsc

Lint

PASSED - ESLint completed with 52 warnings (all pre-existing, not related to this PR). No errors found.

The warnings are related to:

  • TypeScript any type usage in existing code
  • Unused variables in existing components

These warnings existed before this PR and are not introduced by the documentation changes.

Tests

PASSED - All 192 tests passed successfully.

Test Suites: 23 passed, 23 total
Tests:       192 passed, 192 total
Snapshots:   0 total

Changes Made

PR Title and Description Updated:

  • Changed title from "Dines/t UI not cli" to "docs: clarify TUI and CLI terminology in README"
  • Added comprehensive PR description explaining the changes, type of change, and testing performed
  • Filled out the PR checklist to indicate all requirements are met

No Code Changes Required:
This PR only modifies documentation (README.md). The code review found no convention violations, KISS violations, or code duplication issues. All builds, lints, and tests pass successfully.


Review performed in Runloop Devbox

@dines-rl
dines-rl merged commit 6ab24a5 into main Jan 21, 2026
14 of 15 checks passed
@dines-rl
dines-rl deleted the dines/TUI-not-CLI branch January 21, 2026 23:19
@dines-rl

dines-rl commented Jan 21, 2026

Copy link
Copy Markdown
Contributor Author

🤖 PR Review Agent

✅ Set up devbox environment
❌ Clone repository and checkout PR

Failed to clone repo
❌ Check CI/CD status
❌ Scan reviewer comments
❌ Install review tools


SSH in to interact: rli devbox ssh dbx_32EQ5YNcTTslNfITJ1GEd
View Devbox

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant